<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2012 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: AnnotatedXMLStreamWriter.html 813 2013-12-23 16:52:26Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.xml;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import javax.xml.stream.XMLStreamException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import javax.xml.stream.XMLStreamWriter;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>/**<a name="line.13"></a>
<span class="sourceLineNo">014</span> * {@link XMLStreamWriter} that adds an extra annotation element to an XML document as it is written.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * The annotation element will be added as the first element inside the top-level document element.<a name="line.15"></a>
<span class="sourceLineNo">016</span> *<a name="line.16"></a>
<span class="sourceLineNo">017</span> * &lt;p&gt;<a name="line.17"></a>
<span class="sourceLineNo">018</span> * This class can be used in combination with {@link AnnotatedXMLStreamReader} to transparently annotate XML documents.<a name="line.18"></a>
<span class="sourceLineNo">019</span> * &lt;/p&gt;<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * @see AnnotatedXMLStreamReader<a name="line.21"></a>
<span class="sourceLineNo">022</span> */<a name="line.22"></a>
<span class="sourceLineNo">023</span>public abstract class AnnotatedXMLStreamWriter extends StreamWriterDelegate {<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>    private final StringBuilder trailingSpace = new StringBuilder();<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>    // State:<a name="line.27"></a>
<span class="sourceLineNo">028</span>    //  0 = before document element<a name="line.28"></a>
<span class="sourceLineNo">029</span>    //  1 = after document element but before annotation element<a name="line.29"></a>
<span class="sourceLineNo">030</span>    //  2 = after annotation element<a name="line.30"></a>
<span class="sourceLineNo">031</span>    private byte state;<a name="line.31"></a>
<span class="sourceLineNo">032</span>    private boolean needEnding;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    public AnnotatedXMLStreamWriter(XMLStreamWriter parent) {<a name="line.34"></a>
<span class="sourceLineNo">035</span>        super(parent);<a name="line.35"></a>
<span class="sourceLineNo">036</span>    }<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>    @Override<a name="line.38"></a>
<span class="sourceLineNo">039</span>    public void writeStartElement(String localName) throws XMLStreamException {<a name="line.39"></a>
<span class="sourceLineNo">040</span>        this.checkStartElement();<a name="line.40"></a>
<span class="sourceLineNo">041</span>        super.writeStartElement(localName);<a name="line.41"></a>
<span class="sourceLineNo">042</span>    }<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>    @Override<a name="line.44"></a>
<span class="sourceLineNo">045</span>    public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException {<a name="line.45"></a>
<span class="sourceLineNo">046</span>        this.checkStartElement();<a name="line.46"></a>
<span class="sourceLineNo">047</span>        super.writeStartElement(namespaceURI, localName);<a name="line.47"></a>
<span class="sourceLineNo">048</span>    }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    @Override<a name="line.50"></a>
<span class="sourceLineNo">051</span>    public void writeStartElement(String prefix, String namespaceURI, String localName) throws XMLStreamException {<a name="line.51"></a>
<span class="sourceLineNo">052</span>        this.checkStartElement();<a name="line.52"></a>
<span class="sourceLineNo">053</span>        super.writeStartElement(prefix, namespaceURI, localName);<a name="line.53"></a>
<span class="sourceLineNo">054</span>    }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    @Override<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException {<a name="line.57"></a>
<span class="sourceLineNo">058</span>        if (this.state == 0)<a name="line.58"></a>
<span class="sourceLineNo">059</span>            this.writeStartElement(namespaceURI, localName);            // super.writeEndDocument() will add closing tag for us<a name="line.59"></a>
<span class="sourceLineNo">060</span>        else<a name="line.60"></a>
<span class="sourceLineNo">061</span>            super.writeEmptyElement(namespaceURI, localName);<a name="line.61"></a>
<span class="sourceLineNo">062</span>    }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>    @Override<a name="line.64"></a>
<span class="sourceLineNo">065</span>    public void writeEmptyElement(String prefix, String namespaceURI, String localName) throws XMLStreamException {<a name="line.65"></a>
<span class="sourceLineNo">066</span>        if (this.state == 0)<a name="line.66"></a>
<span class="sourceLineNo">067</span>            this.writeStartElement(prefix, namespaceURI, localName);    // super.writeEndDocument() will add closing tag for us<a name="line.67"></a>
<span class="sourceLineNo">068</span>        else<a name="line.68"></a>
<span class="sourceLineNo">069</span>            super.writeEmptyElement(prefix, namespaceURI, localName);<a name="line.69"></a>
<span class="sourceLineNo">070</span>    }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    @Override<a name="line.72"></a>
<span class="sourceLineNo">073</span>    public void writeEmptyElement(String localName) throws XMLStreamException {<a name="line.73"></a>
<span class="sourceLineNo">074</span>        if (this.state == 0)<a name="line.74"></a>
<span class="sourceLineNo">075</span>            this.writeStartElement(localName);                          // super.writeEndDocument() will add closing tag for us<a name="line.75"></a>
<span class="sourceLineNo">076</span>        else<a name="line.76"></a>
<span class="sourceLineNo">077</span>            super.writeEmptyElement(localName);<a name="line.77"></a>
<span class="sourceLineNo">078</span>    }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>    @Override<a name="line.80"></a>
<span class="sourceLineNo">081</span>    public void writeComment(String data) throws XMLStreamException {<a name="line.81"></a>
<span class="sourceLineNo">082</span>        this.checkNonWhitespace();<a name="line.82"></a>
<span class="sourceLineNo">083</span>        super.writeComment(data);<a name="line.83"></a>
<span class="sourceLineNo">084</span>    }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>    @Override<a name="line.86"></a>
<span class="sourceLineNo">087</span>    public void writeProcessingInstruction(String target) throws XMLStreamException {<a name="line.87"></a>
<span class="sourceLineNo">088</span>        this.checkNonWhitespace();<a name="line.88"></a>
<span class="sourceLineNo">089</span>        super.writeProcessingInstruction(target);<a name="line.89"></a>
<span class="sourceLineNo">090</span>    }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    @Override<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public void writeProcessingInstruction(String target, String data) throws XMLStreamException {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        this.checkNonWhitespace();<a name="line.94"></a>
<span class="sourceLineNo">095</span>        super.writeProcessingInstruction(target, data);<a name="line.95"></a>
<span class="sourceLineNo">096</span>    }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span>    @Override<a name="line.98"></a>
<span class="sourceLineNo">099</span>    public void writeCData(String data) throws XMLStreamException {<a name="line.99"></a>
<span class="sourceLineNo">100</span>        this.checkNonWhitespace();<a name="line.100"></a>
<span class="sourceLineNo">101</span>        super.writeCData(data);<a name="line.101"></a>
<span class="sourceLineNo">102</span>    }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>    @Override<a name="line.104"></a>
<span class="sourceLineNo">105</span>    public void writeDTD(String dtd) throws XMLStreamException {<a name="line.105"></a>
<span class="sourceLineNo">106</span>        this.checkNonWhitespace();<a name="line.106"></a>
<span class="sourceLineNo">107</span>        super.writeDTD(dtd);<a name="line.107"></a>
<span class="sourceLineNo">108</span>    }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span>    @Override<a name="line.110"></a>
<span class="sourceLineNo">111</span>    public void writeEntityRef(String name) throws XMLStreamException {<a name="line.111"></a>
<span class="sourceLineNo">112</span>        this.checkNonWhitespace();<a name="line.112"></a>
<span class="sourceLineNo">113</span>        super.writeEntityRef(name);<a name="line.113"></a>
<span class="sourceLineNo">114</span>    }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>    @Override<a name="line.116"></a>
<span class="sourceLineNo">117</span>    public void writeCharacters(String text) throws XMLStreamException {<a name="line.117"></a>
<span class="sourceLineNo">118</span>        this.checkWhitespace(text);<a name="line.118"></a>
<span class="sourceLineNo">119</span>        super.writeCharacters(text);<a name="line.119"></a>
<span class="sourceLineNo">120</span>    }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span>    @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span>    public void writeCharacters(char[] text, int start, int len) throws XMLStreamException {<a name="line.123"></a>
<span class="sourceLineNo">124</span>        this.checkWhitespace(new String(text, start, len));<a name="line.124"></a>
<span class="sourceLineNo">125</span>        super.writeCharacters(text, start, len);<a name="line.125"></a>
<span class="sourceLineNo">126</span>    }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    @Override<a name="line.128"></a>
<span class="sourceLineNo">129</span>    public void writeEndDocument() throws XMLStreamException {<a name="line.129"></a>
<span class="sourceLineNo">130</span>        this.checkNonWhitespace();<a name="line.130"></a>
<span class="sourceLineNo">131</span>        super.writeEndDocument();<a name="line.131"></a>
<span class="sourceLineNo">132</span>    }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>    @Override<a name="line.134"></a>
<span class="sourceLineNo">135</span>    public void writeEndElement() throws XMLStreamException {<a name="line.135"></a>
<span class="sourceLineNo">136</span>        this.checkNonWhitespace();<a name="line.136"></a>
<span class="sourceLineNo">137</span>        super.writeEndElement();<a name="line.137"></a>
<span class="sourceLineNo">138</span>    }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span>    private void checkStartElement() throws XMLStreamException {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        switch (this.state) {<a name="line.141"></a>
<span class="sourceLineNo">142</span>        case 0:<a name="line.142"></a>
<span class="sourceLineNo">143</span>            this.state++;<a name="line.143"></a>
<span class="sourceLineNo">144</span>            break;<a name="line.144"></a>
<span class="sourceLineNo">145</span>        case 1:<a name="line.145"></a>
<span class="sourceLineNo">146</span>            this.checkNonWhitespace();<a name="line.146"></a>
<span class="sourceLineNo">147</span>            break;<a name="line.147"></a>
<span class="sourceLineNo">148</span>        default:<a name="line.148"></a>
<span class="sourceLineNo">149</span>            break;<a name="line.149"></a>
<span class="sourceLineNo">150</span>        }<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span>    private void checkNonWhitespace() throws XMLStreamException {<a name="line.153"></a>
<span class="sourceLineNo">154</span>        if (this.state != 1)<a name="line.154"></a>
<span class="sourceLineNo">155</span>            return;<a name="line.155"></a>
<span class="sourceLineNo">156</span>        this.state++;<a name="line.156"></a>
<span class="sourceLineNo">157</span>        this.addAnnotationElement(this.getParent());<a name="line.157"></a>
<span class="sourceLineNo">158</span>        if (this.trailingSpace.length() &gt; 0)<a name="line.158"></a>
<span class="sourceLineNo">159</span>            super.writeCharacters(this.trailingSpace.toString());<a name="line.159"></a>
<span class="sourceLineNo">160</span>    }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span>    private void checkWhitespace(String text) throws XMLStreamException {<a name="line.162"></a>
<span class="sourceLineNo">163</span>        if (this.state != 1)<a name="line.163"></a>
<span class="sourceLineNo">164</span>            return;<a name="line.164"></a>
<span class="sourceLineNo">165</span>        if (text.trim().length() == 0)<a name="line.165"></a>
<span class="sourceLineNo">166</span>            this.trailingSpace.append(text);<a name="line.166"></a>
<span class="sourceLineNo">167</span>        else<a name="line.167"></a>
<span class="sourceLineNo">168</span>            this.checkNonWhitespace();<a name="line.168"></a>
<span class="sourceLineNo">169</span>    }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span>    /**<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * Get the whitespace found between the opening document tag and the first non-space child.<a name="line.172"></a>
<span class="sourceLineNo">173</span>     */<a name="line.173"></a>
<span class="sourceLineNo">174</span>    protected String getTrailingSpace() {<a name="line.174"></a>
<span class="sourceLineNo">175</span>        return this.trailingSpace.toString();<a name="line.175"></a>
<span class="sourceLineNo">176</span>    }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span>    /**<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * Add the annotation element.<a name="line.179"></a>
<span class="sourceLineNo">180</span>     *<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * &lt;p&gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span>     * This method should write the start element, followed by by any nested content, and then lastly the<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * end element for the annotation element.<a name="line.183"></a>
<span class="sourceLineNo">184</span>     * &lt;/p&gt;<a name="line.184"></a>
<span class="sourceLineNo">185</span>     *<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * @param writer output to which the annotation element should be written<a name="line.186"></a>
<span class="sourceLineNo">187</span>     */<a name="line.187"></a>
<span class="sourceLineNo">188</span>    protected abstract void addAnnotationElement(XMLStreamWriter writer) throws XMLStreamException;<a name="line.188"></a>
<span class="sourceLineNo">189</span>}<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>




























































</pre>
</div>
</body>
</html>
